home *** CD-ROM | disk | FTP | other *** search
/ Light ROM 3 / Light ROM 3 - Disc 2.iso / programs / amiga / animfile / aned11 / aned11.lha / animed / animed.doc < prev    next >
Text File  |  1993-06-02  |  15KB  |  391 lines
  1. <><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
  2.  
  3.  
  4.                            AnimEd & PlayIMED
  5.  
  6.                         Written by Brandon Bogle
  7.  
  8.  
  9.                   Copyright ⌐ 1993 i╖media Corporation
  10.                           All Rights Reserved
  11.  
  12.  
  13.                       Doc File Created: 06.02.93
  14.  
  15. <><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
  16.  
  17.  
  18. DISTRIBUTION INFO
  19.  
  20.     'AnimEd' & the companion player program 'PlayIMED' are being
  21.     distributed 'as-is' as Shareware.
  22.  
  23.     I would like to say right up front: This software is NOT CRIPPLED
  24.     IN ANY WAY.  Any items that are ghosted merely haven't been
  25.     completed.  I will not REQUIRE anyone to send me anything to get
  26.     a DECENT USABLE version.  I don't think it's in the spirit of 
  27.     'SHARE-ware'.  However, if you find this software usable 
  28.     (oh great, here comes the pitch... ), a donation of $25 or so 
  29.     would be greatly appreciated. (beer & twinkies would also work)
  30.     No matter what, please send me any feedback, suggestions, bug 
  31.     reports, special requests, or anything else you can think of,
  32.     and I will do my best to respond to them. (addresses at end of doc)
  33.  
  34.     This archive may be freely distributed in its original form, but
  35.     not for commercial purposes.
  36.  
  37.     The program 'PlayIMED' may, however, be distributed with IMED-ANIMS
  38.     that have been created using this software.
  39.  
  40.     The entire risk as to the use of this program is assumed by the user.
  41.     In no event will the author be liable for any direct, indirect, 
  42.     incidental, or consequential damages derived from the use of this 
  43.     software.
  44.  
  45.  
  46.  
  47. SYSTEM REQUIREMENTS
  48.  
  49.     AnimEd     -AmigaDOS 2.0/ECS minimum.   AmigaDOS 3.0/AGA recommended
  50.                 4 meg. RAM recommended. (the more, the better)
  51.  
  52.     PlayIMED   -AmigaDOS 2.0/ECS minimum.   AmigaDOS 3.0/AGA recommended
  53.                 Recommended memory size depends on ANIMS you 
  54.                 wish to play.
  55.  
  56.  
  57.  
  58. INSTALLATION
  59.  
  60.     1.  Create a drawer or partition on your system to put animations in,
  61.         called 'VID:'.
  62.  
  63.         If you create a partition, name it 'VID:'
  64.  
  65.         If you create a drawer, add an assign to your s/user-startup
  66.             something like:
  67.  
  68.                     ASSIGN VID: DH1:MyAnimDrawer
  69.  
  70.         THIS IS VERY IMPORTANT.  THE SOFTWARE INTERNALLY READS & 
  71.         WRITES FILES IN 'VID:'.  YOU CANNOT CHANGE THIS. 
  72.  
  73.     2.  Copy the contents of the included fonts directory to your
  74.         'FONTS:' directory.
  75.  
  76.     3.  I have included 2 versions of 'AnimEd'.
  77.  
  78.             'AnimEd_68000' is for 68000 cpu based machines.
  79.             'AnimEd_68020' is for 68020,68030,68040 machines.
  80.  
  81.         Rename the appropriate version to 'AnimEd' and put it,
  82.         along with 'AnimEd.info', wherever you want.
  83.         It can be run from the Workbench or CLI.
  84.  
  85.     4.  I have included 2 versions of 'PlayIMED'.
  86.  
  87.             'PlayIMED_68000' is for 68000 cpu based machines.
  88.             'PlayIMED_68020' is for 68020,68030,68040 machines.
  89.  
  90.         Rename the appropriate version to 'PlayIMED' and copy it to
  91.         your 'C:' directory.  It can only be executed from the CLI.
  92.  
  93.  
  94.  
  95.  
  96. SOFTWARE OVERVIEW
  97.  
  98.     I originally started this whole project because I needed a flexible
  99.     animation format that I could use to, most importantly, play back
  100.     smaller-than-full-screen anims within a positional window on an
  101.     existing bitmap background.  Oh, and also with audio that could
  102.     be synchronized to the frame.  And, I needed ANIMs that could
  103.     be pre-loaded (as many as can fit in RAM) and be instantly cued,
  104.     full screen or in windows on existing screens.  AND, users needed
  105.     to be able to interact with the animations as they were playing,
  106.     pausing them when they wanted to, etc.  The list goes on and on.
  107.  
  108.     I have developed a system in which I have implemented all of these
  109.     features.  What I have released in this archive is an editor for
  110.     video/audio/interaction events and a distributable player program.
  111.  
  112.     Some of the other features, such as positional windows, preloading
  113.     multiple anims, etc., are only available if you are using this
  114.     system in your own software.  I will be releasing the source code,
  115.     dev docs & other stuff by request only, and for a small fee.  I have
  116.     not had time to decide exactly how to distribute it or at what
  117.     cost, so if you're interested, please contact me and I'll work
  118.     something out.  Maybe I'll have gotten some sleep by then... ;-O
  119.  
  120.     Limitations
  121.     -----------
  122.     No HAM modes are supported.
  123.     
  124.     Playback is only in HI-RES INTERLACE
  125.         - This means anims can be from 2 - 16 colors on a non-AGA machine
  126.         - or 2 - 256 colors on an AGA machine
  127.  
  128.     Anim resolution cannot be over 640x400.
  129.  
  130.     I developed this system for a specific purpose, so I apologize if
  131.     these limitations make your animating life miserable. They are not 
  132.     oversights, but merely weren't needed at the time of development.
  133.     I might change this in a future release.
  134.  
  135.  
  136.  
  137. FILE STRUCTURE
  138.  
  139.     IMED-ANIMs, as they've come to be known as, consist of 4 files:
  140.  
  141.         '.head'   file  -=> Contains general anim data such as resolution,
  142.                             depth, colors, etc., as well as the first
  143.                             frame of the animation.
  144.  
  145.         '.body'   file  -=> Basically contains compressed data for each
  146.                             frame.  IMED-ANIMs, right now, use delta
  147.                             compression, similar to ANIM 7.
  148.  
  149.         '.audio'  file  -=> Contains audio cues and audio samples.
  150.  
  151.         '.timing' file  -=> Contains individual frame timing, interaction,
  152.                             & other stuff.
  153.  
  154.     These files are created in 'VID:' and look like this example:
  155.  
  156.         TomServo_IMED_ANIM.head
  157.         TomServo_IMED_ANIM.body
  158.         TomServo_IMED_ANIM.audio
  159.         TomServo_IMED_ANIM.timing
  160.  
  161.     To play this anim with 'PlayIMED' you would just type (in CLI):
  162.  
  163.         PlayIMED TomServo
  164.  
  165.  
  166.  
  167. ----------------------------------------------------------------------------
  168. 'PlayIMED' DOCS
  169.  
  170.  
  171.     See the 'FILE STRUCTURE' section above for an example.
  172.  
  173.  
  174.  
  175.  
  176. ----------------------------------------------------------------------------
  177. 'AnimEd'   DOCS         For AnimEd v1.1 current as of 06.02.93
  178.  
  179.  
  180.     I am writing these very quickly, and I'm losing my Coke/Twinkie high,
  181.     so please forgive me if some of this is a bit unclear...
  182.  
  183.     I will start this off in a tutorial fashion, and then describe
  184.     some specifics after that.
  185.  
  186.  
  187.     OK. Go ahead and start the program. (DBL click from WB, or type
  188.     'AnimEd' from the CLI)
  189.  
  190.     Unless you already have an IMED-ANIM in VID:, you will have to convert
  191.     an existing ANIM5 or ANIM7 of yours to the IMED-ANIM format.
  192.  
  193.     Click on the 'ANIM FILE I/O & Utility' button in the lower right of
  194.     the main control panel.
  195.  
  196.     The screen will slide down.  Select 'ANIM5,7 to IMED-ANIM' from the
  197.     'Conversion Utilities' group of buttons to convert one of your
  198.     ANIMS to the IMED-ANIM format.
  199.  
  200.     ***MAKE SURE you have a 'VID:' on your system!!! (see installation
  201.     above)
  202.  
  203.     After your ANIM has been converted (your original will remain un-
  204.     changed), click on 'ANIM FILE I/O & Utility' again, and then click
  205.     'Load IMED-ANIM' to load your newly created IMED-ANIM.
  206.  
  207.     After a few seconds (depending on the length) you can start editing
  208.     the anim.  The frames of the ANIM will appear in  the middle section
  209.     of your screen.  They have a frame number underneath, and an outline
  210.     around the currently selected frame.  If you cannot see these clearly,
  211.     you can change the pen color by selecting 'Frames Pen Color' in the
  212.     lower utility panel (accessed by pressing 'ANIM FILE I/O & Utility',
  213.     remember?).
  214.  
  215.  
  216.     AUDIO EDITING TOOLS
  217.     -------------------
  218.     After an ANIM is loaded, you will see a grid at the bottom of the screen.
  219.     Each of the four rows of the grid represent an audio channel (1-4).
  220.  
  221.     To add an event, make sure the cycle gadget in the lower left of
  222.     the main control panel is set to 'Edit Event Mode', and click on a
  223.     free grid space.
  224.  
  225.     To edit an event, make sure the cycle gadget in the lower left of
  226.     the main control panel is set to 'Edit Event Mode', and click
  227.     anywhere in the event.
  228.  
  229.     To delete an event, make sure the cycle gadget in the lower left of
  230.     the main control panel is set to 'Delete Event Mode', and click on the
  231.     event.
  232.  
  233.     The only event types that are implemented now are:
  234.  
  235.         -Start Sample       - easy. The only wierd thing is if you want
  236.                               the sample to repeat forever (until you stop
  237.                               it), enter 0 in the REPS gadget.
  238.         -Stop  Sample       - even easier.
  239.         -Change Per/Vol     - Lets you modify the period (playback rate),
  240.                               and volume of a sample over time.
  241.  
  242.         For Example:  If you wanted a sample to fade up and continue
  243.             playing for the rest of the animation (looping, like maybe
  244.             the sound of a helicopter?), you would add a start sample
  245.             event with VOLUME at 0 and REPS at 0 (for infinite looping).
  246.             Press 'Okay' and then place a 'Change Per/Vol' event right
  247.             after it, set the start and end frames for the event, and
  248.             set the final volume.
  249.  
  250.     Samples can be loaded, cleared from memory, played, & stopped, using
  251.     the buttons below the Sample List on the left.
  252.  
  253.     Mod support is coming REAL soon, (like probably next week) but doesn't
  254.     do anything now.
  255.  
  256.  
  257.     VIDEO EDITING TOOLS
  258.     -------------------
  259.     Another 'wierd-on my-part-but-I'm-comfortable-with-it' thing:
  260.     All frame timing info is specified as a delay from the last frame.
  261.  
  262.     This means that if you select frame 100 (for example) and enter a
  263.     delay time of 2 seconds/300000 microseconds (millionths of a second),
  264.     FRAME 99 WILL HOLD FOR THAT AMOUNT OF TIME.
  265.  
  266.     You can have different delays assigned to each frame. Use the cycle
  267.     gadget to cycle between the 4 timing presets and the 1 'Use Time ->'
  268.     option, which would allow you to enter your own time delay using
  269.     the Secs: and Mcro: gadgets.  After you select the timing for the
  270.     frame you're on, you must 'Apply To:' either the currently selected
  271.     frame, or a range of frames, by pressing the appropriate buttons.
  272.  
  273.     Below that panel is one more cycle gadget.  It has four options:
  274.  
  275.         -Play Frame Normally
  276.             * If this is set for a frame, that frame will play
  277.               normally.
  278.  
  279.         -Pause - Wait for Button Press
  280.             * If this is set for a frame, the animation will pause
  281.               when it reaches that frame and will continue when the
  282.               left mouse button is PRESSED.
  283.  
  284.         -Pause - Wait for Button Release
  285.             * Just like the last event, but the animation will continue
  286.               when the left mouse button is PRESSED AND RELEASED.
  287.  
  288.         -Stop Animation At This Frame
  289.             * If this is set for a frame, the animation will stop when
  290.               it reaches that frame.
  291.  
  292.  
  293.     ONE MORE THING ABOUT ANIMATIONS
  294.     -------------------------------
  295.     Right now, IMED-ANIMS follow the same rules of organization as 
  296.     ANIM5s and ANIM7s...
  297.  
  298.     If you intend to loop the animation, the ANIM5 or ANIM7 you convert
  299.     from must be set up to loop.  DPaint does this. If you are creating
  300.     the ANIM with ADPro, use the 'WrapUp' option in the ANIM saver to
  301.     do this.
  302.  
  303.     Also, when an ANIM5, ANIM7, or IMED-ANIM loops, it loops back to the
  304.     third frame (which is why those extra two frames are tacked on the
  305.     end of a looping anim. They are delta changes to create the first
  306.     two frames of the animation. The actual first two frames of the 
  307.     ANIM are stored differently from the rest, so a player cannot
  308.     directly loop back to them.)
  309.  
  310.     The reason I bring this up is because if you place an event on
  311.     the second frame of a looping IMED-ANIM, it will play only on the
  312.     first time through because it loops back to the third frame.
  313.     If the anim is truly set up to loop (w/DPaint, etc.), the last
  314.     frame will be frame two, and the second to last frame will be
  315.     frame one.  SO, to play a sound effect (or whatever else) on the
  316.     second frame of a looping animation, you would place the event at
  317.     frame two, AND on the last frame.
  318.  
  319.  
  320.  
  321.     SOME OTHER STUFF
  322.     ----------------
  323.     Down in the lower panel (accessed by pressing 'ANIM File I/O & Utility',
  324.     remember) there are 2 more buttons of interest.
  325.  
  326.         -Free Audio Device
  327.             * This will free all four audio channels for use by other
  328.               software.
  329.  
  330.         -Allocate & Lock Audio Device
  331.             * This will gain access to all four audio channels and make
  332.               them un-accessable to other software in the system.
  333.  
  334.  
  335.  
  336.  
  337.  
  338. CLOSING STATEMENTS
  339.  
  340.     SOME upcoming features (some of which are already kinda/sorta working 
  341.     'here at the lab') include:
  342.  
  343.         -Drag & Drop frame editing (not sure how to handle the audio
  344.             yet... any suggestions?)
  345.  
  346.         -A new compression format to facilitate reverse playback.
  347.             (not coming in the NEAR future, but has been started)
  348.  
  349.         -Looping sections (with delta compression) without adding
  350.             the corresponding amount of frames to the anim.
  351.  
  352.         -MOD & MIDI event capability (working on currently)
  353.  
  354.         -Exporting IMED-ANIMS in ANIM5, ANIM7, & ANIM8 format.
  355.             (also working on currently. Keep the twinkies comin',
  356.             and the MST3K playing in the background =*)
  357.  
  358.     This software has been tested, works, and is in use on our
  359.     A4000s (Tom Servo & Crow T. Robot), A3000's, and the A1200.
  360.  
  361.     (of course, somebody's probably heard that from AXIOM regarding
  362.     Pixel-3D Pro, one of the most bug-infested pieces of trash
  363.     available for the Amiga. >=-(  It offends me that they're charging
  364.     money for it. But I digress...)
  365.  
  366.     LET ME KNOW IF THERE ARE -ANY- COMPATIBILITY PROBLEMS WITH YOUR SYSTEM
  367.     AND I WILL REMEDY THEM FOR A FUTURE RELEASE.
  368.  
  369.     I think that's all for now.  Again, _SORRY_ for the crummy docs.
  370.  
  371.     Here is where you can reach me:
  372.  
  373.     Compuserve:         71301,2754
  374.     BIX:                bbogle
  375.  
  376.     Centaur BBS:        BrandonB
  377.  
  378.  
  379.     i╖media Corp.
  380.     P.O. Box 84477
  381.     Vancouver, WA 98684-0477
  382.  
  383.                                               ENJOY :-)
  384.  
  385.     P.S. Don't forget to watch Mystery Science Theater 3000 EVERY
  386.          Friday @ Midnight and Saturday at 10 AM and 7 PM on
  387.          Comedy Central.
  388.  
  389.             - Byte me, it's fun!
  390.  
  391.